Skip to content

Add architecture documentation and fix inaccuracies#1737

Merged
kmcginnes merged 2 commits intoaws:mainfrom
kmcginnes:update-content-clarity
Apr 29, 2026
Merged

Add architecture documentation and fix inaccuracies#1737
kmcginnes merged 2 commits intoaws:mainfrom
kmcginnes:update-content-clarity

Conversation

@kmcginnes
Copy link
Copy Markdown
Collaborator

Description

Add an Architecture section to docs/development.md and fix documentation inaccuracies, addressing the remaining items in #1159.

  • Architecture section — System overview with Mermaid diagram showing client → proxy → database flow (with optional direct path), monorepo structure, key libraries with rationale, and the connector/explorer pattern
  • Build for Production fix — Removed incorrect claim about two dist folders; the proxy server has no build step since migrating to native type stripping
  • Dangling reference fix — Replaced broken "See below" text in deploy-with-docker.md with a link to the connections feature page

Validation

  • All content verified against actual package.json scripts, source imports, and project structure
  • pnpm checks passes (lint, format, types)
  • Mermaid diagram renders correctly on GitHub

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I have verified pnpm checks passes with no errors.
  • I have verified pnpm test passes with no failures.
  • I have covered new added functionality with unit tests if necessary.
  • I have updated documentation if necessary.

…s#1159)

- Add Architecture section to development.md covering system overview
  with Mermaid diagram, monorepo structure, key libraries with rationale,
  and the connector/explorer pattern
- Fix incorrect Build for Production section that claimed two dist folders
  (proxy server has no build step since migrating to native type stripping)
- Fix dangling 'See below' reference in deploy-with-docker.md, now links
  to the connections feature page
@kmcginnes kmcginnes marked this pull request as ready for review April 28, 2026 22:59
@kmcginnes kmcginnes merged commit 4905ba8 into aws:main Apr 29, 2026
3 checks passed
@kmcginnes kmcginnes deleted the update-content-clarity branch April 29, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update content to be more clear and focused

2 participants